/*
 * Copyright (C) 2012-2013  Romain DUBOIS
 * 
 * This file is part of NeMoS - Network and Modular Software
 * 
 * NeMoS is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * NeMoS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with NeMoS.  If not, see <http://www.gnu.org/licenses/>.
 */
package nemos.swing;

import java.util.Locale;

import javax.swing.Action;

/**
 * IConverter : converter interface.
 * 
 * <p>
 * Services registered under this interface provide Swing {@link Action}s. Each
 * action is designed by a String ID. This interface separates the components
 * displaying the action (buttons, menu items, ...) from the controllers which
 * decide when the action is available.
 * </p>
 * 
 * @author Romain DUBOIS
 */
public interface IConverter {

    /**
     * Convert (i.e. deserialize) the String value into this converter target
     * type.
     * 
     * @param pValue
     *            The value to convert
     * @param pType
     *            The target type
     * @param pName
     *            The parameter name
     * @param pLocale
     *            The locale to use
     * @return The converted object
     * @throws ConvertException
     *             If value can not be converted
     */
    Object convert(final String pValue, final Class<?> pType, final String pName, Locale pLocale)
            throws ConvertException;

    /**
     * Get the converter target type.
     * 
     * @return The converter target type.
     */
    Class<?> getType();
}
